<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>pyokx.ws_data_structures &mdash; AntBot 0.0.1 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=d45e8c67"></script>
        <script src="_static/doctools.js?v=888ff710"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="redis_tools.config" href="redis_tools.config.html" />
    <link rel="prev" title="pyokx.ws_clients.WsUtils" href="pyokx.ws_clients.WsUtils.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html" class="icon icon-home">
            AntBot
          </a>
              <div class="version">
                0.0.1
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="autodocumentation_python.html">autodocumentation_python</a></li>
<li class="toctree-l1"><a class="reference internal" href="firebase_tools.BaseClasses.html">firebase_tools.BaseClasses</a></li>
<li class="toctree-l1"><a class="reference internal" href="firebase_tools.FirestoreClient.html">firebase_tools.FirestoreClient</a></li>
<li class="toctree-l1"><a class="reference internal" href="firebase_tools.authenticate.html">firebase_tools.authenticate</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.dashboard.html">h2o_dashboard.dashboard</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.documentation_page.html">h2o_dashboard.pages.documentation_page</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.okx_dashbaord_page.okx_antbot_okx_premium_indicator_handler.html">h2o_dashboard.pages.okx_dashbaord_page.okx_antbot_okx_premium_indicator_handler</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.okx_dashbaord_page.okx_dashboard_page.html">h2o_dashboard.pages.okx_dashbaord_page.okx_dashboard_page</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.okx_streams.html">h2o_dashboard.pages.okx_streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.overview_page.html">h2o_dashboard.pages.overview_page</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.util.html">h2o_dashboard.util</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.wave_auth.html">h2o_dashboard.wave_auth</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.Futures_Exchange_Client.html">pyokx.Futures_Exchange_Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.InstrumentSearcher.html">pyokx.InstrumentSearcher</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.data_structures.html">pyokx.data_structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Account.html">pyokx.low_rest_api.Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.BlockTrading.html">pyokx.low_rest_api.BlockTrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Convert.html">pyokx.low_rest_api.Convert</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.CopyTrading.html">pyokx.low_rest_api.CopyTrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Earning.html">pyokx.low_rest_api.Earning</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.FDBroker.html">pyokx.low_rest_api.FDBroker</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Funding.html">pyokx.low_rest_api.Funding</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Grid.html">pyokx.low_rest_api.Grid</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.MarketData.html">pyokx.low_rest_api.MarketData</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.NDBroker.html">pyokx.low_rest_api.NDBroker</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.PublicData.html">pyokx.low_rest_api.PublicData</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.SpreadTrading.html">pyokx.low_rest_api.SpreadTrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Status.html">pyokx.low_rest_api.Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.SubAccount.html">pyokx.low_rest_api.SubAccount</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Trade.html">pyokx.low_rest_api.Trade</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.TradingData.html">pyokx.low_rest_api.TradingData</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.client.html">pyokx.low_rest_api.client</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.consts.html">pyokx.low_rest_api.consts</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.exceptions.html">pyokx.low_rest_api.exceptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.utils.html">pyokx.low_rest_api.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.WssMarketDataService.html">pyokx.okx_market_maker.market_data_service.WssMarketDataService</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.Instrument.html">pyokx.okx_market_maker.market_data_service.model.Instrument</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.MarkPx.html">pyokx.okx_market_maker.market_data_service.model.MarkPx</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.OrderBook.html">pyokx.okx_market_maker.market_data_service.model.OrderBook</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.Tickers.html">pyokx.okx_market_maker.market_data_service.model.Tickers</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.order_management_service.WssOrderManagementService.html">pyokx.okx_market_maker.order_management_service.WssOrderManagementService</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.order_management_service.model.Order.html">pyokx.okx_market_maker.order_management_service.model.Order</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.order_management_service.model.OrderRequest.html">pyokx.okx_market_maker.order_management_service.model.OrderRequest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.WssPositionManagementService.html">pyokx.okx_market_maker.position_management_service.WssPositionManagementService</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.model.Account.html">pyokx.okx_market_maker.position_management_service.model.Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.model.BalanceAndPosition.html">pyokx.okx_market_maker.position_management_service.model.BalanceAndPosition</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.model.Positions.html">pyokx.okx_market_maker.position_management_service.model.Positions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.run_sample_market_maker.html">pyokx.okx_market_maker.run_sample_market_maker</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.settings.html">pyokx.okx_market_maker.settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.BaseStrategy.html">pyokx.okx_market_maker.strategy.BaseStrategy</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.SampleMM.html">pyokx.okx_market_maker.strategy.SampleMM</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.model.StrategyMeasurement.html">pyokx.okx_market_maker.strategy.model.StrategyMeasurement</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.model.StrategyOrder.html">pyokx.okx_market_maker.strategy.model.StrategyOrder</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.params.ParamsLoader.html">pyokx.okx_market_maker.strategy.params.ParamsLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.risk.RiskCalculator.html">pyokx.okx_market_maker.strategy.risk.RiskCalculator</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.risk.RiskSnapshot.html">pyokx.okx_market_maker.strategy.risk.RiskSnapshot</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.tests.test_strategy.html">pyokx.okx_market_maker.tests.test_strategy</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.InstrumentUtil.html">pyokx.okx_market_maker.utils.InstrumentUtil</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html">pyokx.okx_market_maker.utils.OkxEnum</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.TdModeUtil.html">pyokx.okx_market_maker.utils.TdModeUtil</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.WsOrderUtil.html">pyokx.okx_market_maker.utils.WsOrderUtil</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.redis_structured_reports.html">pyokx.redis_structured_reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.redis_structured_streams.html">pyokx.redis_structured_streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.rest_handling.html">pyokx.rest_handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.rest_messages_service.html">pyokx.rest_messages_service</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.strategy_handling.html">pyokx.strategy_handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.AccountTest.html">pyokx.test.AccountTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.BlockTradingTest.html">pyokx.test.BlockTradingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.BrokerTest.html">pyokx.test.BrokerTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.ConvertTest.html">pyokx.test.ConvertTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.CopyTradingTest.html">pyokx.test.CopyTradingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.EarningTest.html">pyokx.test.EarningTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.FundingTest.html">pyokx.test.FundingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.GridTest.html">pyokx.test.GridTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.MarketTest.html">pyokx.test.MarketTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.PublicDataTest.html">pyokx.test.PublicDataTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.SpreadTest.html">pyokx.test.SpreadTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.StackingTest.html">pyokx.test.StackingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.SubAccountTest.html">pyokx.test.SubAccountTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.TradeTest.html">pyokx.test.TradeTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.TradingDataTest.html">pyokx.test.TradingDataTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.WsPrivateAsyncTest.html">pyokx.test.WsPrivateAsyncTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.WsPublicAsyncTest.html">pyokx.test.WsPublicAsyncTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.websocket_handling.html">pyokx.websocket_handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WebSocketFactory.html">pyokx.ws_clients.WebSocketFactory</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WsPprivateAsync.html">pyokx.ws_clients.WsPprivateAsync</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WsPublicAsync.html">pyokx.ws_clients.WsPublicAsync</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WsUtils.html">pyokx.ws_clients.WsUtils</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">pyokx.ws_data_structures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannel"><code class="docutils literal notranslate"><span class="pre">AccountChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannel.arg"><code class="docutils literal notranslate"><span class="pre">AccountChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannel.data"><code class="docutils literal notranslate"><span class="pre">AccountChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannel.model_config"><code class="docutils literal notranslate"><span class="pre">AccountChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">AccountChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelInputArgs.ccy"><code class="docutils literal notranslate"><span class="pre">AccountChannelInputArgs.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">AccountChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelInputArgs.extraParams"><code class="docutils literal notranslate"><span class="pre">AccountChannelInputArgs.extraParams</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">AccountChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountChannelInputArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelReturnArgs"><code class="docutils literal notranslate"><span class="pre">AccountChannelReturnArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.channel"><code class="docutils literal notranslate"><span class="pre">AccountChannelReturnArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.model_config"><code class="docutils literal notranslate"><span class="pre">AccountChannelReturnArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountChannelReturnArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.uid"><code class="docutils literal notranslate"><span class="pre">AccountChannelReturnArgs.uid</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData.balData"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData.balData</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData.eventType"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData.eventType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData.model_config"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData.model_fields"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData.pTime"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData.pTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData.posData"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData.posData</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData.trades"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionData.trades</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.arg"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.data"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.model_config"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelInputArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelReturnArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.channel"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelReturnArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.model_config"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelReturnArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelReturnArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.uid"><code class="docutils literal notranslate"><span class="pre">BalanceAndPositionsChannelReturnArgs.uid</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick"><code class="docutils literal notranslate"><span class="pre">CandleStick</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.close"><code class="docutils literal notranslate"><span class="pre">CandleStick.close</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.high"><code class="docutils literal notranslate"><span class="pre">CandleStick.high</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.is_closed"><code class="docutils literal notranslate"><span class="pre">CandleStick.is_closed</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.low"><code class="docutils literal notranslate"><span class="pre">CandleStick.low</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.model_config"><code class="docutils literal notranslate"><span class="pre">CandleStick.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.model_fields"><code class="docutils literal notranslate"><span class="pre">CandleStick.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.model_post_init"><code class="docutils literal notranslate"><span class="pre">CandleStick.model_post_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.open"><code class="docutils literal notranslate"><span class="pre">CandleStick.open</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick.timestamp"><code class="docutils literal notranslate"><span class="pre">CandleStick.timestamp</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannel"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.arg"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.data"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.from_array"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannel.from_array()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.model_config"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannelInputArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_post_init"><code class="docutils literal notranslate"><span class="pre">IndexCandleSticksChannelInputArgs.model_post_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers"><code class="docutils literal notranslate"><span class="pre">IndexTickers</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.high24h"><code class="docutils literal notranslate"><span class="pre">IndexTickers.high24h</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.idxPx"><code class="docutils literal notranslate"><span class="pre">IndexTickers.idxPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.instId"><code class="docutils literal notranslate"><span class="pre">IndexTickers.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.low24h"><code class="docutils literal notranslate"><span class="pre">IndexTickers.low24h</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.model_config"><code class="docutils literal notranslate"><span class="pre">IndexTickers.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.model_fields"><code class="docutils literal notranslate"><span class="pre">IndexTickers.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.open24h"><code class="docutils literal notranslate"><span class="pre">IndexTickers.open24h</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.sodUtc0"><code class="docutils literal notranslate"><span class="pre">IndexTickers.sodUtc0</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.sodUtc8"><code class="docutils literal notranslate"><span class="pre">IndexTickers.sodUtc8</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers.ts"><code class="docutils literal notranslate"><span class="pre">IndexTickers.ts</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannel"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannel.arg"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannel.data"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannel.model_config"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannelInputArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_post_init"><code class="docutils literal notranslate"><span class="pre">IndexTickersChannelInputArgs.model_post_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannel"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannel.arg"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannel.data"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannel.model_config"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.instType"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannelInputArgs.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannelInputArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_post_init"><code class="docutils literal notranslate"><span class="pre">InstrumentsChannelInputArgs.model_post_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice"><code class="docutils literal notranslate"><span class="pre">MarkPrice</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice.instId"><code class="docutils literal notranslate"><span class="pre">MarkPrice.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice.instType"><code class="docutils literal notranslate"><span class="pre">MarkPrice.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice.markPx"><code class="docutils literal notranslate"><span class="pre">MarkPrice.markPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice.model_config"><code class="docutils literal notranslate"><span class="pre">MarkPrice.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice.model_fields"><code class="docutils literal notranslate"><span class="pre">MarkPrice.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice.model_post_init"><code class="docutils literal notranslate"><span class="pre">MarkPrice.model_post_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice.ts"><code class="docutils literal notranslate"><span class="pre">MarkPrice.ts</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.arg"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.data"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.from_array"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannel.from_array()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.model_config"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannelInputArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_post_init"><code class="docutils literal notranslate"><span class="pre">MarkPriceCandleSticksChannelInputArgs.model_post_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannel"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannel.arg"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannel.data"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannel.model_config"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannelInputArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_post_init"><code class="docutils literal notranslate"><span class="pre">MarkPriceChannelInputArgs.model_post_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookChannel"><code class="docutils literal notranslate"><span class="pre">OrderBookChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookChannel.action"><code class="docutils literal notranslate"><span class="pre">OrderBookChannel.action</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookChannel.arg"><code class="docutils literal notranslate"><span class="pre">OrderBookChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookChannel.data"><code class="docutils literal notranslate"><span class="pre">OrderBookChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookChannel.from_array"><code class="docutils literal notranslate"><span class="pre">OrderBookChannel.from_array()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookChannel.model_config"><code class="docutils literal notranslate"><span class="pre">OrderBookChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">OrderBookChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData"><code class="docutils literal notranslate"><span class="pre">OrderBookData</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.asks"><code class="docutils literal notranslate"><span class="pre">OrderBookData.asks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.bids"><code class="docutils literal notranslate"><span class="pre">OrderBookData.bids</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.checksum"><code class="docutils literal notranslate"><span class="pre">OrderBookData.checksum</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.instId"><code class="docutils literal notranslate"><span class="pre">OrderBookData.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.model_config"><code class="docutils literal notranslate"><span class="pre">OrderBookData.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.model_fields"><code class="docutils literal notranslate"><span class="pre">OrderBookData.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.prevSeqId"><code class="docutils literal notranslate"><span class="pre">OrderBookData.prevSeqId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.seqId"><code class="docutils literal notranslate"><span class="pre">OrderBookData.seqId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData.ts"><code class="docutils literal notranslate"><span class="pre">OrderBookData.ts</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookInputArgs"><code class="docutils literal notranslate"><span class="pre">OrderBookInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">OrderBookInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">OrderBookInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">OrderBookInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">OrderBookInputArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs"><code class="docutils literal notranslate"><span class="pre">OrderBookReturnArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs.channel"><code class="docutils literal notranslate"><span class="pre">OrderBookReturnArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs.instId"><code class="docutils literal notranslate"><span class="pre">OrderBookReturnArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs.model_config"><code class="docutils literal notranslate"><span class="pre">OrderBookReturnArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">OrderBookReturnArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannel"><code class="docutils literal notranslate"><span class="pre">OrdersChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannel.arg"><code class="docutils literal notranslate"><span class="pre">OrdersChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannel.data"><code class="docutils literal notranslate"><span class="pre">OrdersChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannel.model_config"><code class="docutils literal notranslate"><span class="pre">OrdersChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">OrdersChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">OrdersChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">OrdersChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.instFamily"><code class="docutils literal notranslate"><span class="pre">OrdersChannelInputArgs.instFamily</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">OrdersChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.instType"><code class="docutils literal notranslate"><span class="pre">OrdersChannelInputArgs.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">OrdersChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">OrdersChannelInputArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.channel"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.instFamily"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs.instFamily</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.instId"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.instType"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.model_config"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.uid"><code class="docutils literal notranslate"><span class="pre">OrdersChannelReturnArgs.uid</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannel"><code class="docutils literal notranslate"><span class="pre">PositionsChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannel.arg"><code class="docutils literal notranslate"><span class="pre">PositionsChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannel.data"><code class="docutils literal notranslate"><span class="pre">PositionsChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannel.model_config"><code class="docutils literal notranslate"><span class="pre">PositionsChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">PositionsChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.extraParams"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs.extraParams</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.instFamily"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs.instFamily</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.instType"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">PositionsChannelInputArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.channel"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.instFamily"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs.instFamily</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.instId"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.instType"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.model_config"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.uid"><code class="docutils literal notranslate"><span class="pre">PositionsChannelReturnArgs.uid</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit"><code class="docutils literal notranslate"><span class="pre">PriceLimit</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.buyLmt"><code class="docutils literal notranslate"><span class="pre">PriceLimit.buyLmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.enabled"><code class="docutils literal notranslate"><span class="pre">PriceLimit.enabled</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.instId"><code class="docutils literal notranslate"><span class="pre">PriceLimit.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.model_config"><code class="docutils literal notranslate"><span class="pre">PriceLimit.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.model_fields"><code class="docutils literal notranslate"><span class="pre">PriceLimit.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.model_post_init"><code class="docutils literal notranslate"><span class="pre">PriceLimit.model_post_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.sellLmt"><code class="docutils literal notranslate"><span class="pre">PriceLimit.sellLmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit.ts"><code class="docutils literal notranslate"><span class="pre">PriceLimit.ts</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannel"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannel.arg"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannel.data"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannel.model_config"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannelInputArgs.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_post_init"><code class="docutils literal notranslate"><span class="pre">PriceLimitChannelInputArgs.model_post_init()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannel"><code class="docutils literal notranslate"><span class="pre">TickersChannel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannel.arg"><code class="docutils literal notranslate"><span class="pre">TickersChannel.arg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannel.data"><code class="docutils literal notranslate"><span class="pre">TickersChannel.data</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannel.model_config"><code class="docutils literal notranslate"><span class="pre">TickersChannel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannel.model_fields"><code class="docutils literal notranslate"><span class="pre">TickersChannel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelInputArgs"><code class="docutils literal notranslate"><span class="pre">TickersChannelInputArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelInputArgs.channel"><code class="docutils literal notranslate"><span class="pre">TickersChannelInputArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelInputArgs.instId"><code class="docutils literal notranslate"><span class="pre">TickersChannelInputArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelInputArgs.model_config"><code class="docutils literal notranslate"><span class="pre">TickersChannelInputArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelInputArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">TickersChannelInputArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelReturnArgs"><code class="docutils literal notranslate"><span class="pre">TickersChannelReturnArgs</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.channel"><code class="docutils literal notranslate"><span class="pre">TickersChannelReturnArgs.channel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.instId"><code class="docutils literal notranslate"><span class="pre">TickersChannelReturnArgs.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.model_config"><code class="docutils literal notranslate"><span class="pre">TickersChannelReturnArgs.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.model_fields"><code class="docutils literal notranslate"><span class="pre">TickersChannelReturnArgs.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder"><code class="docutils literal notranslate"><span class="pre">WSOrder</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.accFillSz"><code class="docutils literal notranslate"><span class="pre">WSOrder.accFillSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.algoClOrdId"><code class="docutils literal notranslate"><span class="pre">WSOrder.algoClOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.algoId"><code class="docutils literal notranslate"><span class="pre">WSOrder.algoId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.amendResult"><code class="docutils literal notranslate"><span class="pre">WSOrder.amendResult</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.amendSource"><code class="docutils literal notranslate"><span class="pre">WSOrder.amendSource</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.attachAlgoClOrdId"><code class="docutils literal notranslate"><span class="pre">WSOrder.attachAlgoClOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.attachAlgoOrds"><code class="docutils literal notranslate"><span class="pre">WSOrder.attachAlgoOrds</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.avgPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.avgPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.cTime"><code class="docutils literal notranslate"><span class="pre">WSOrder.cTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.cancelSource"><code class="docutils literal notranslate"><span class="pre">WSOrder.cancelSource</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.category"><code class="docutils literal notranslate"><span class="pre">WSOrder.category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.ccy"><code class="docutils literal notranslate"><span class="pre">WSOrder.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.clOrdId"><code class="docutils literal notranslate"><span class="pre">WSOrder.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.code"><code class="docutils literal notranslate"><span class="pre">WSOrder.code</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.execType"><code class="docutils literal notranslate"><span class="pre">WSOrder.execType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fee"><code class="docutils literal notranslate"><span class="pre">WSOrder.fee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.feeCcy"><code class="docutils literal notranslate"><span class="pre">WSOrder.feeCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillFee"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillFee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillFeeCcy"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillFeeCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillFwdPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillFwdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillMarkPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillMarkPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillMarkVol"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillMarkVol</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillNotionalUsd"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillNotionalUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillPnl"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillPnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillPxUsd"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillPxUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillPxVol"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillPxVol</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillSz"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.fillTime"><code class="docutils literal notranslate"><span class="pre">WSOrder.fillTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.instId"><code class="docutils literal notranslate"><span class="pre">WSOrder.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.instType"><code class="docutils literal notranslate"><span class="pre">WSOrder.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.lastPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.lastPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.lever"><code class="docutils literal notranslate"><span class="pre">WSOrder.lever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.model_config"><code class="docutils literal notranslate"><span class="pre">WSOrder.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.model_fields"><code class="docutils literal notranslate"><span class="pre">WSOrder.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.msg"><code class="docutils literal notranslate"><span class="pre">WSOrder.msg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.notionalUsd"><code class="docutils literal notranslate"><span class="pre">WSOrder.notionalUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.ordId"><code class="docutils literal notranslate"><span class="pre">WSOrder.ordId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.ordType"><code class="docutils literal notranslate"><span class="pre">WSOrder.ordType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.pnl"><code class="docutils literal notranslate"><span class="pre">WSOrder.pnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.posSide"><code class="docutils literal notranslate"><span class="pre">WSOrder.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.px"><code class="docutils literal notranslate"><span class="pre">WSOrder.px</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.pxType"><code class="docutils literal notranslate"><span class="pre">WSOrder.pxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.pxUsd"><code class="docutils literal notranslate"><span class="pre">WSOrder.pxUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.pxVol"><code class="docutils literal notranslate"><span class="pre">WSOrder.pxVol</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.quickMgnType"><code class="docutils literal notranslate"><span class="pre">WSOrder.quickMgnType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.rebate"><code class="docutils literal notranslate"><span class="pre">WSOrder.rebate</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.rebateCcy"><code class="docutils literal notranslate"><span class="pre">WSOrder.rebateCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.reduceOnly"><code class="docutils literal notranslate"><span class="pre">WSOrder.reduceOnly</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.reqId"><code class="docutils literal notranslate"><span class="pre">WSOrder.reqId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.side"><code class="docutils literal notranslate"><span class="pre">WSOrder.side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.slOrdPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.slOrdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.slTriggerPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.slTriggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.slTriggerPxType"><code class="docutils literal notranslate"><span class="pre">WSOrder.slTriggerPxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.source"><code class="docutils literal notranslate"><span class="pre">WSOrder.source</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.state"><code class="docutils literal notranslate"><span class="pre">WSOrder.state</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.stpId"><code class="docutils literal notranslate"><span class="pre">WSOrder.stpId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.stpMode"><code class="docutils literal notranslate"><span class="pre">WSOrder.stpMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.sz"><code class="docutils literal notranslate"><span class="pre">WSOrder.sz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.tag"><code class="docutils literal notranslate"><span class="pre">WSOrder.tag</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.tdMode"><code class="docutils literal notranslate"><span class="pre">WSOrder.tdMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.tgtCcy"><code class="docutils literal notranslate"><span class="pre">WSOrder.tgtCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.tpOrdPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.tpOrdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.tpTriggerPx"><code class="docutils literal notranslate"><span class="pre">WSOrder.tpTriggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.tpTriggerPxType"><code class="docutils literal notranslate"><span class="pre">WSOrder.tpTriggerPxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.tradeId"><code class="docutils literal notranslate"><span class="pre">WSOrder.tradeId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder.uTime"><code class="docutils literal notranslate"><span class="pre">WSOrder.uTime</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition"><code class="docutils literal notranslate"><span class="pre">WSPosition</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.adl"><code class="docutils literal notranslate"><span class="pre">WSPosition.adl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.availPos"><code class="docutils literal notranslate"><span class="pre">WSPosition.availPos</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.avgPx"><code class="docutils literal notranslate"><span class="pre">WSPosition.avgPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.baseBal"><code class="docutils literal notranslate"><span class="pre">WSPosition.baseBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.baseBorrowed"><code class="docutils literal notranslate"><span class="pre">WSPosition.baseBorrowed</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.baseInterest"><code class="docutils literal notranslate"><span class="pre">WSPosition.baseInterest</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.bePx"><code class="docutils literal notranslate"><span class="pre">WSPosition.bePx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.bizRefId"><code class="docutils literal notranslate"><span class="pre">WSPosition.bizRefId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.bizRefType"><code class="docutils literal notranslate"><span class="pre">WSPosition.bizRefType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.cTime"><code class="docutils literal notranslate"><span class="pre">WSPosition.cTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.ccy"><code class="docutils literal notranslate"><span class="pre">WSPosition.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.closeOrderAlgo"><code class="docutils literal notranslate"><span class="pre">WSPosition.closeOrderAlgo</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.deltaBS"><code class="docutils literal notranslate"><span class="pre">WSPosition.deltaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.deltaPA"><code class="docutils literal notranslate"><span class="pre">WSPosition.deltaPA</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.fee"><code class="docutils literal notranslate"><span class="pre">WSPosition.fee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.fundingFee"><code class="docutils literal notranslate"><span class="pre">WSPosition.fundingFee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.gammaBS"><code class="docutils literal notranslate"><span class="pre">WSPosition.gammaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.gammaPA"><code class="docutils literal notranslate"><span class="pre">WSPosition.gammaPA</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.idxPx"><code class="docutils literal notranslate"><span class="pre">WSPosition.idxPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.imr"><code class="docutils literal notranslate"><span class="pre">WSPosition.imr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.instId"><code class="docutils literal notranslate"><span class="pre">WSPosition.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.instType"><code class="docutils literal notranslate"><span class="pre">WSPosition.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.interest"><code class="docutils literal notranslate"><span class="pre">WSPosition.interest</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.last"><code class="docutils literal notranslate"><span class="pre">WSPosition.last</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.lever"><code class="docutils literal notranslate"><span class="pre">WSPosition.lever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.liab"><code class="docutils literal notranslate"><span class="pre">WSPosition.liab</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.liabCcy"><code class="docutils literal notranslate"><span class="pre">WSPosition.liabCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.liqPenalty"><code class="docutils literal notranslate"><span class="pre">WSPosition.liqPenalty</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.liqPx"><code class="docutils literal notranslate"><span class="pre">WSPosition.liqPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.margin"><code class="docutils literal notranslate"><span class="pre">WSPosition.margin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.markPx"><code class="docutils literal notranslate"><span class="pre">WSPosition.markPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.mgnMode"><code class="docutils literal notranslate"><span class="pre">WSPosition.mgnMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.mgnRatio"><code class="docutils literal notranslate"><span class="pre">WSPosition.mgnRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.mmr"><code class="docutils literal notranslate"><span class="pre">WSPosition.mmr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.model_config"><code class="docutils literal notranslate"><span class="pre">WSPosition.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.model_fields"><code class="docutils literal notranslate"><span class="pre">WSPosition.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.notionalUsd"><code class="docutils literal notranslate"><span class="pre">WSPosition.notionalUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.optVal"><code class="docutils literal notranslate"><span class="pre">WSPosition.optVal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.pTime"><code class="docutils literal notranslate"><span class="pre">WSPosition.pTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.pnl"><code class="docutils literal notranslate"><span class="pre">WSPosition.pnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.pos"><code class="docutils literal notranslate"><span class="pre">WSPosition.pos</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.posCcy"><code class="docutils literal notranslate"><span class="pre">WSPosition.posCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.posId"><code class="docutils literal notranslate"><span class="pre">WSPosition.posId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.posSide"><code class="docutils literal notranslate"><span class="pre">WSPosition.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.quoteBal"><code class="docutils literal notranslate"><span class="pre">WSPosition.quoteBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.quoteBorrowed"><code class="docutils literal notranslate"><span class="pre">WSPosition.quoteBorrowed</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.quoteInterest"><code class="docutils literal notranslate"><span class="pre">WSPosition.quoteInterest</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.realizedPnl"><code class="docutils literal notranslate"><span class="pre">WSPosition.realizedPnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.spotInUseAmt"><code class="docutils literal notranslate"><span class="pre">WSPosition.spotInUseAmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.spotInUseCcy"><code class="docutils literal notranslate"><span class="pre">WSPosition.spotInUseCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.thetaBS"><code class="docutils literal notranslate"><span class="pre">WSPosition.thetaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.thetaPA"><code class="docutils literal notranslate"><span class="pre">WSPosition.thetaPA</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.tradeId"><code class="docutils literal notranslate"><span class="pre">WSPosition.tradeId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.uTime"><code class="docutils literal notranslate"><span class="pre">WSPosition.uTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.upl"><code class="docutils literal notranslate"><span class="pre">WSPosition.upl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.uplLastPx"><code class="docutils literal notranslate"><span class="pre">WSPosition.uplLastPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.uplRatio"><code class="docutils literal notranslate"><span class="pre">WSPosition.uplRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.uplRatioLastPx"><code class="docutils literal notranslate"><span class="pre">WSPosition.uplRatioLastPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.usdPx"><code class="docutils literal notranslate"><span class="pre">WSPosition.usdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.vegaBS"><code class="docutils literal notranslate"><span class="pre">WSPosition.vegaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition.vegaPA"><code class="docutils literal notranslate"><span class="pre">WSPosition.vegaPA</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.WebSocketConnectionConfig"><code class="docutils literal notranslate"><span class="pre">WebSocketConnectionConfig</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.channels"><code class="docutils literal notranslate"><span class="pre">WebSocketConnectionConfig.channels</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.model_config"><code class="docutils literal notranslate"><span class="pre">WebSocketConnectionConfig.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.model_fields"><code class="docutils literal notranslate"><span class="pre">WebSocketConnectionConfig.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.model_post_init"><code class="docutils literal notranslate"><span class="pre">WebSocketConnectionConfig.model_post_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.name"><code class="docutils literal notranslate"><span class="pre">WebSocketConnectionConfig.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.wss_url"><code class="docutils literal notranslate"><span class="pre">WebSocketConnectionConfig.wss_url</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element"><code class="docutils literal notranslate"><span class="pre">ws_balData_element</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element.cashBal"><code class="docutils literal notranslate"><span class="pre">ws_balData_element.cashBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element.ccy"><code class="docutils literal notranslate"><span class="pre">ws_balData_element.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element.model_config"><code class="docutils literal notranslate"><span class="pre">ws_balData_element.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element.model_fields"><code class="docutils literal notranslate"><span class="pre">ws_balData_element.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element.model_post_init"><code class="docutils literal notranslate"><span class="pre">ws_balData_element.model_post_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element.uTime"><code class="docutils literal notranslate"><span class="pre">ws_balData_element.uTime</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element"><code class="docutils literal notranslate"><span class="pre">ws_posData_element</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.avgPx"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.avgPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.ccy"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.instId"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.instType"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.mgnMode"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.mgnMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.model_config"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.model_fields"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.model_post_init"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.model_post_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.pos"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.pos</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.posCcy"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.posCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.posId"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.posId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.posSide"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.tradeId"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.tradeId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element.uTime"><code class="docutils literal notranslate"><span class="pre">ws_posData_element.uTime</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element"><code class="docutils literal notranslate"><span class="pre">ws_trades_element</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element.instId"><code class="docutils literal notranslate"><span class="pre">ws_trades_element.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element.model_config"><code class="docutils literal notranslate"><span class="pre">ws_trades_element.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element.model_fields"><code class="docutils literal notranslate"><span class="pre">ws_trades_element.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element.model_post_init"><code class="docutils literal notranslate"><span class="pre">ws_trades_element.model_post_init()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element.tradeId"><code class="docutils literal notranslate"><span class="pre">ws_trades_element.tradeId</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="redis_tools.config.html">redis_tools.config</a></li>
<li class="toctree-l1"><a class="reference internal" href="redis_tools.consumers.html">redis_tools.consumers</a></li>
<li class="toctree-l1"><a class="reference internal" href="redis_tools.utils.html">redis_tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest_app.html">rest_app</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.api_keys.html">routers.api_keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.login.html">routers.login</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.okx.html">routers.okx</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.okx_authentication.html">routers.okx_authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.signup.html">routers.signup</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.command_execution.html">shared.command_execution</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.config.html">shared.config</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.configuration_parser.html">shared.configuration_parser</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.data_processing_utils.html">shared.data_processing_utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.file_directory_ops.html">shared.file_directory_ops</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.logging.html">shared.logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.string_dict_utils.html">shared.string_dict_utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.tmp_shared.html">shared.tmp_shared</a></li>
<li class="toctree-l1"><a class="reference internal" href="tradingview_tools.tradingview_widgets.html">tradingview_tools.tradingview_widgets</a></li>
<li class="toctree-l1"><a class="reference internal" href="websocket_app.html">websocket_app</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">AntBot</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">pyokx.ws_data_structures</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/pyokx.ws_data_structures.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="module-pyokx.ws_data_structures">
<span id="pyokx-ws-data-structures"></span><h1>pyokx.ws_data_structures<a class="headerlink" href="#module-pyokx.ws_data_structures" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">AccountChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelReturnArgs" title="pyokx.ws_data_structures.AccountChannelReturnArgs"><span class="pre">AccountChannelReturnArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.AccountBalanceData" title="pyokx.data_structures.AccountBalanceData"><span class="pre">AccountBalanceData</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#AccountChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.AccountChannelReturnArgs" title="pyokx.ws_data_structures.AccountChannelReturnArgs"><span class="pre">AccountChannelReturnArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.AccountBalanceData" title="pyokx.data_structures.AccountBalanceData"><span class="pre">AccountBalanceData</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=AccountChannelReturnArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[AccountBalanceData],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">AccountChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraParams</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#AccountChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelInputArgs.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelInputArgs.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelInputArgs.extraParams">
<span class="sig-name descname"><span class="pre">extraParams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'extraParams'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelInputArgs.extraParams" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'ccy':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'extraParams':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelReturnArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">AccountChannelReturnArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#AccountChannelReturnArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelReturnArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelReturnArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelReturnArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelReturnArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uid':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.AccountChannelReturnArgs.uid">
<span class="sig-name descname"><span class="pre">uid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uid'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.AccountChannelReturnArgs.uid" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">BalanceAndPositionData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eventType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">balData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element" title="pyokx.ws_data_structures.ws_balData_element"><span class="pre">ws_balData_element</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posData</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element" title="pyokx.ws_data_structures.ws_posData_element"><span class="pre">ws_posData_element</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trades</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element" title="pyokx.ws_data_structures.ws_trades_element"><span class="pre">ws_trades_element</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#BalanceAndPositionData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData.balData">
<span class="sig-name descname"><span class="pre">balData</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.ws_balData_element" title="pyokx.ws_data_structures.ws_balData_element"><span class="pre">ws_balData_element</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'balData'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData.balData" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData.eventType">
<span class="sig-name descname"><span class="pre">eventType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'eventType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData.eventType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'balData':</span> <span class="pre">FieldInfo(annotation=List[ws_balData_element],</span> <span class="pre">required=True),</span> <span class="pre">'eventType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posData':</span> <span class="pre">FieldInfo(annotation=List[ws_posData_element],</span> <span class="pre">required=True),</span> <span class="pre">'trades':</span> <span class="pre">FieldInfo(annotation=List[ws_trades_element],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData.pTime">
<span class="sig-name descname"><span class="pre">pTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData.pTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData.posData">
<span class="sig-name descname"><span class="pre">posData</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.ws_posData_element" title="pyokx.ws_data_structures.ws_posData_element"><span class="pre">ws_posData_element</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posData'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData.posData" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionData.trades">
<span class="sig-name descname"><span class="pre">trades</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.ws_trades_element" title="pyokx.ws_data_structures.ws_trades_element"><span class="pre">ws_trades_element</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'trades'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionData.trades" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">BalanceAndPositionsChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs" title="pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs"><span class="pre">BalanceAndPositionsChannelReturnArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData" title="pyokx.ws_data_structures.BalanceAndPositionData"><span class="pre">BalanceAndPositionData</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#BalanceAndPositionsChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs" title="pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs"><span class="pre">BalanceAndPositionsChannelReturnArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.BalanceAndPositionData" title="pyokx.ws_data_structures.BalanceAndPositionData"><span class="pre">BalanceAndPositionData</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=BalanceAndPositionsChannelReturnArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[BalanceAndPositionData],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">BalanceAndPositionsChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#BalanceAndPositionsChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">BalanceAndPositionsChannelReturnArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#BalanceAndPositionsChannelReturnArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uid':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.uid">
<span class="sig-name descname"><span class="pre">uid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uid'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs.uid" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">CandleStick</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">open</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">high</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">low</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">close</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_closed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#CandleStick"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.close">
<span class="sig-name descname"><span class="pre">close</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'close'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.close" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.high">
<span class="sig-name descname"><span class="pre">high</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'high'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.high" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.is_closed">
<span class="sig-name descname"><span class="pre">is_closed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'is_closed'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.is_closed" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.low">
<span class="sig-name descname"><span class="pre">low</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'low'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.low" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'close':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'high':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'is_closed':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'low':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'open':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'timestamp':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.open">
<span class="sig-name descname"><span class="pre">open</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'open'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.open" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.CandleStick.timestamp">
<span class="sig-name descname"><span class="pre">timestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timestamp'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.CandleStick.timestamp" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">IndexCandleSticksChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs" title="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs"><span class="pre">IndexCandleSticksChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick" title="pyokx.ws_data_structures.CandleStick"><span class="pre">CandleStick</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#IndexCandleSticksChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs" title="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs"><span class="pre">IndexCandleSticksChannelInputArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick" title="pyokx.ws_data_structures.CandleStick"><span class="pre">CandleStick</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannel.from_array">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs" title="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs"><span class="pre">IndexCandleSticksChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#IndexCandleSticksChannel.from_array"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.from_array" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=IndexCandleSticksChannelInputArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[CandleStick],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">IndexCandleSticksChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#IndexCandleSticksChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">IndexTickers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idxPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">high24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">low24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">open24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sodUtc0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sodUtc8</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#IndexTickers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.high24h">
<span class="sig-name descname"><span class="pre">high24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'high24h'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.high24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.idxPx">
<span class="sig-name descname"><span class="pre">idxPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'idxPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.idxPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.low24h">
<span class="sig-name descname"><span class="pre">low24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'low24h'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.low24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'high24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'idxPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'low24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'open24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sodUtc0':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sodUtc8':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ts':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.open24h">
<span class="sig-name descname"><span class="pre">open24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'open24h'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.open24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.sodUtc0">
<span class="sig-name descname"><span class="pre">sodUtc0</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sodUtc0'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.sodUtc0" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.sodUtc8">
<span class="sig-name descname"><span class="pre">sodUtc8</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sodUtc8'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.sodUtc8" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickers.ts">
<span class="sig-name descname"><span class="pre">ts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickers.ts" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">IndexTickersChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs" title="pyokx.ws_data_structures.IndexTickersChannelInputArgs"><span class="pre">IndexTickersChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers" title="pyokx.ws_data_structures.IndexTickers"><span class="pre">IndexTickers</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#IndexTickersChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs" title="pyokx.ws_data_structures.IndexTickersChannelInputArgs"><span class="pre">IndexTickersChannelInputArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.IndexTickers" title="pyokx.ws_data_structures.IndexTickers"><span class="pre">IndexTickers</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=IndexTickersChannelInputArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[IndexTickers],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">IndexTickersChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#IndexTickersChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">InstrumentsChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs" title="pyokx.ws_data_structures.InstrumentsChannelInputArgs"><span class="pre">InstrumentsChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Instrument" title="pyokx.data_structures.Instrument"><span class="pre">Instrument</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#InstrumentsChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs" title="pyokx.ws_data_structures.InstrumentsChannelInputArgs"><span class="pre">InstrumentsChannelInputArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Instrument" title="pyokx.data_structures.Instrument"><span class="pre">Instrument</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=InstrumentsChannelInputArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[Instrument],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">InstrumentsChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#InstrumentsChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannelInputArgs.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">MarkPrice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">markPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#MarkPrice"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice.markPx">
<span class="sig-name descname"><span class="pre">markPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'markPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice.markPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'markPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ts':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPrice.ts">
<span class="sig-name descname"><span class="pre">ts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPrice.ts" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">MarkPriceCandleSticksChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs" title="pyokx.ws_data_structures.MarkPriceChannelInputArgs"><span class="pre">MarkPriceChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick" title="pyokx.ws_data_structures.CandleStick"><span class="pre">CandleStick</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#MarkPriceCandleSticksChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs" title="pyokx.ws_data_structures.MarkPriceChannelInputArgs"><span class="pre">MarkPriceChannelInputArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.CandleStick" title="pyokx.ws_data_structures.CandleStick"><span class="pre">CandleStick</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannel.from_array">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs" title="pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs"><span class="pre">MarkPriceCandleSticksChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#MarkPriceCandleSticksChannel.from_array"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.from_array" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=MarkPriceChannelInputArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[CandleStick],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">MarkPriceCandleSticksChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#MarkPriceCandleSticksChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">MarkPriceChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs" title="pyokx.ws_data_structures.MarkPriceChannelInputArgs"><span class="pre">MarkPriceChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice" title="pyokx.ws_data_structures.MarkPrice"><span class="pre">MarkPrice</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#MarkPriceChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs" title="pyokx.ws_data_structures.MarkPriceChannelInputArgs"><span class="pre">MarkPriceChannelInputArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.MarkPrice" title="pyokx.ws_data_structures.MarkPrice"><span class="pre">MarkPrice</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=MarkPriceChannelInputArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[MarkPrice],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">MarkPriceChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#MarkPriceChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">OrderBookChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs" title="pyokx.ws_data_structures.OrderBookReturnArgs"><span class="pre">OrderBookReturnArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData" title="pyokx.ws_data_structures.OrderBookData"><span class="pre">OrderBookData</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrderBookChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookChannel.action">
<span class="sig-name descname"><span class="pre">action</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'action'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookChannel.action" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs" title="pyokx.ws_data_structures.OrderBookReturnArgs"><span class="pre">OrderBookReturnArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookData" title="pyokx.ws_data_structures.OrderBookData"><span class="pre">OrderBookData</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookChannel.from_array">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.OrderBookReturnArgs" title="pyokx.ws_data_structures.OrderBookReturnArgs"><span class="pre">OrderBookReturnArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrderBookChannel.from_array"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookChannel.from_array" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'action':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'arg':</span> <span class="pre">FieldInfo(annotation=OrderBookReturnArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[OrderBookData],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">OrderBookData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Ask" title="pyokx.data_structures.Ask"><span class="pre">Ask</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Bid" title="pyokx.data_structures.Bid"><span class="pre">Bid</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seqId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">checksum</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prevSeqId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrderBookData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.asks">
<span class="sig-name descname"><span class="pre">asks</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Ask" title="pyokx.data_structures.Ask"><span class="pre">Ask</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'asks'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.asks" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.bids">
<span class="sig-name descname"><span class="pre">bids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Bid" title="pyokx.data_structures.Bid"><span class="pre">Bid</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bids'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.bids" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.checksum">
<span class="sig-name descname"><span class="pre">checksum</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'checksum'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.checksum" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'asks':</span> <span class="pre">FieldInfo(annotation=List[Ask],</span> <span class="pre">required=True),</span> <span class="pre">'bids':</span> <span class="pre">FieldInfo(annotation=List[Bid],</span> <span class="pre">required=True),</span> <span class="pre">'checksum':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'prevSeqId':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'seqId':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=True),</span> <span class="pre">'ts':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.prevSeqId">
<span class="sig-name descname"><span class="pre">prevSeqId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'prevSeqId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.prevSeqId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.seqId">
<span class="sig-name descname"><span class="pre">seqId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'seqId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.seqId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookData.ts">
<span class="sig-name descname"><span class="pre">ts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookData.ts" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">OrderBookInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrderBookInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookReturnArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">OrderBookReturnArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrderBookReturnArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookReturnArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookReturnArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookReturnArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookReturnArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookReturnArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookReturnArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookReturnArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrderBookReturnArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrderBookReturnArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">OrdersChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs" title="pyokx.ws_data_structures.OrdersChannelReturnArgs"><span class="pre">OrdersChannelReturnArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder" title="pyokx.ws_data_structures.WSOrder"><span class="pre">WSOrder</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrdersChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs" title="pyokx.ws_data_structures.OrdersChannelReturnArgs"><span class="pre">OrdersChannelReturnArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.WSOrder" title="pyokx.ws_data_structures.WSOrder"><span class="pre">WSOrder</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=OrdersChannelReturnArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[WSOrder],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">OrdersChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instFamily</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrdersChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelInputArgs.instFamily">
<span class="sig-name descname"><span class="pre">instFamily</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instFamily'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.instFamily" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelInputArgs.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instFamily':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">OrdersChannelReturnArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instFamily</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#OrdersChannelReturnArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs.instFamily">
<span class="sig-name descname"><span class="pre">instFamily</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instFamily'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.instFamily" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instFamily':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uid':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.OrdersChannelReturnArgs.uid">
<span class="sig-name descname"><span class="pre">uid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uid'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs.uid" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">PositionsChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs" title="pyokx.ws_data_structures.PositionsChannelReturnArgs"><span class="pre">PositionsChannelReturnArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition" title="pyokx.ws_data_structures.WSPosition"><span class="pre">WSPosition</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#PositionsChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs" title="pyokx.ws_data_structures.PositionsChannelReturnArgs"><span class="pre">PositionsChannelReturnArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.WSPosition" title="pyokx.ws_data_structures.WSPosition"><span class="pre">WSPosition</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=PositionsChannelReturnArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[WSPosition],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">PositionsChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instFamily</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extraParams</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#PositionsChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs.extraParams">
<span class="sig-name descname"><span class="pre">extraParams</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'extraParams'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.extraParams" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs.instFamily">
<span class="sig-name descname"><span class="pre">instFamily</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instFamily'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.instFamily" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'extraParams':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instFamily':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">PositionsChannelReturnArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instFamily</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#PositionsChannelReturnArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs.instFamily">
<span class="sig-name descname"><span class="pre">instFamily</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instFamily'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.instFamily" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instFamily':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uid':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PositionsChannelReturnArgs.uid">
<span class="sig-name descname"><span class="pre">uid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uid'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs.uid" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">PriceLimit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buyLmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sellLmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#PriceLimit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.buyLmt">
<span class="sig-name descname"><span class="pre">buyLmt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'buyLmt'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.buyLmt" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.enabled">
<span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'enabled'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.enabled" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'buyLmt':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'enabled':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sellLmt':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ts':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.sellLmt">
<span class="sig-name descname"><span class="pre">sellLmt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sellLmt'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.sellLmt" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimit.ts">
<span class="sig-name descname"><span class="pre">ts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimit.ts" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">PriceLimitChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs" title="pyokx.ws_data_structures.PriceLimitChannelInputArgs"><span class="pre">PriceLimitChannelInputArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit" title="pyokx.ws_data_structures.PriceLimit"><span class="pre">PriceLimit</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#PriceLimitChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs" title="pyokx.ws_data_structures.PriceLimitChannelInputArgs"><span class="pre">PriceLimitChannelInputArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.ws_data_structures.PriceLimit" title="pyokx.ws_data_structures.PriceLimit"><span class="pre">PriceLimit</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=PriceLimitChannelInputArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[PriceLimit],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">PriceLimitChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#PriceLimitChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">TickersChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelReturnArgs" title="pyokx.ws_data_structures.TickersChannelReturnArgs"><span class="pre">TickersChannelReturnArgs</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Ticker" title="pyokx.data_structures.Ticker"><span class="pre">Ticker</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#TickersChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannel" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannel.arg">
<span class="sig-name descname"><span class="pre">arg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.ws_data_structures.TickersChannelReturnArgs" title="pyokx.ws_data_structures.TickersChannelReturnArgs"><span class="pre">TickersChannelReturnArgs</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'arg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannel.arg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannel.data">
<span class="sig-name descname"><span class="pre">data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.Ticker" title="pyokx.data_structures.Ticker"><span class="pre">Ticker</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'data'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannel.data" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arg':</span> <span class="pre">FieldInfo(annotation=TickersChannelReturnArgs,</span> <span class="pre">required=True),</span> <span class="pre">'data':</span> <span class="pre">FieldInfo(annotation=List[Ticker],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelInputArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">TickersChannelInputArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#TickersChannelInputArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelInputArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelInputArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelInputArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelInputArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelInputArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelInputArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelInputArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelInputArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelInputArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelReturnArgs">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">TickersChannelReturnArgs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#TickersChannelReturnArgs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelReturnArgs" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelReturnArgs.channel">
<span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channel'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.channel" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelReturnArgs.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelReturnArgs.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.TickersChannelReturnArgs.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channel':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.TickersChannelReturnArgs.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">WSOrder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accFillSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoClOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">amendResult</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">amendSource</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attachAlgoClOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attachAlgoOrds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avgPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelSource</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">execType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feeCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillFee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillFeeCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillFwdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillMarkPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillMarkVol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillNotionalUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPxUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPxVol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notionalUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">px</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxVol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quickMgnType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rebate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rebateCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reduceOnly</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reqId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slOrdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slTriggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slTriggerPxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stpId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stpMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tdMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tgtCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpOrdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpTriggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpTriggerPxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tradeId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#WSOrder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.accFillSz">
<span class="sig-name descname"><span class="pre">accFillSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'accFillSz'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.accFillSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.algoClOrdId">
<span class="sig-name descname"><span class="pre">algoClOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoClOrdId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.algoClOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.algoId">
<span class="sig-name descname"><span class="pre">algoId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.algoId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.amendResult">
<span class="sig-name descname"><span class="pre">amendResult</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'amendResult'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.amendResult" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.amendSource">
<span class="sig-name descname"><span class="pre">amendSource</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'amendSource'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.amendSource" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.attachAlgoClOrdId">
<span class="sig-name descname"><span class="pre">attachAlgoClOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'attachAlgoClOrdId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.attachAlgoClOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.attachAlgoOrds">
<span class="sig-name descname"><span class="pre">attachAlgoOrds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'attachAlgoOrds'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.attachAlgoOrds" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.avgPx">
<span class="sig-name descname"><span class="pre">avgPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'avgPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.avgPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.cTime">
<span class="sig-name descname"><span class="pre">cTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.cTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.cancelSource">
<span class="sig-name descname"><span class="pre">cancelSource</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cancelSource'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.cancelSource" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.category">
<span class="sig-name descname"><span class="pre">category</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'category'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.category" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.code">
<span class="sig-name descname"><span class="pre">code</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'code'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.code" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.execType">
<span class="sig-name descname"><span class="pre">execType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'execType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.execType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fee">
<span class="sig-name descname"><span class="pre">fee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fee'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.feeCcy">
<span class="sig-name descname"><span class="pre">feeCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'feeCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.feeCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillFee">
<span class="sig-name descname"><span class="pre">fillFee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillFee'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillFee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillFeeCcy">
<span class="sig-name descname"><span class="pre">fillFeeCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillFeeCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillFeeCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillFwdPx">
<span class="sig-name descname"><span class="pre">fillFwdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillFwdPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillFwdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillMarkPx">
<span class="sig-name descname"><span class="pre">fillMarkPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillMarkPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillMarkPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillMarkVol">
<span class="sig-name descname"><span class="pre">fillMarkVol</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillMarkVol'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillMarkVol" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillNotionalUsd">
<span class="sig-name descname"><span class="pre">fillNotionalUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillNotionalUsd'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillNotionalUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillPnl">
<span class="sig-name descname"><span class="pre">fillPnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPnl'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillPnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillPx">
<span class="sig-name descname"><span class="pre">fillPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillPxUsd">
<span class="sig-name descname"><span class="pre">fillPxUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPxUsd'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillPxUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillPxVol">
<span class="sig-name descname"><span class="pre">fillPxVol</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPxVol'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillPxVol" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillSz">
<span class="sig-name descname"><span class="pre">fillSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillSz'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.fillTime">
<span class="sig-name descname"><span class="pre">fillTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.fillTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.lastPx">
<span class="sig-name descname"><span class="pre">lastPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lastPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.lastPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.lever">
<span class="sig-name descname"><span class="pre">lever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lever'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.lever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'accFillSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoClOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'amendResult':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'amendSource':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'attachAlgoClOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'attachAlgoOrds':</span> <span class="pre">FieldInfo(annotation=List[str],</span> <span class="pre">required=True),</span> <span class="pre">'avgPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cancelSource':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'category':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'code':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'execType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'feeCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillFee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillFeeCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillFwdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillMarkPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillMarkVol':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillNotionalUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillPnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillPxUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillPxVol':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lastPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lever':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'msg':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'notionalUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'px':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxVol':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quickMgnType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'rebate':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'rebateCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'reduceOnly':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'reqId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'side':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slOrdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slTriggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slTriggerPxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'source':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'state':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'stpId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'stpMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tdMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tgtCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpOrdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpTriggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpTriggerPxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tradeId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.msg">
<span class="sig-name descname"><span class="pre">msg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'msg'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.msg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.notionalUsd">
<span class="sig-name descname"><span class="pre">notionalUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'notionalUsd'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.notionalUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.ordId">
<span class="sig-name descname"><span class="pre">ordId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.ordId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.ordType">
<span class="sig-name descname"><span class="pre">ordType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.ordType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.pnl">
<span class="sig-name descname"><span class="pre">pnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pnl'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.pnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.px">
<span class="sig-name descname"><span class="pre">px</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'px'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.px" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.pxType">
<span class="sig-name descname"><span class="pre">pxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.pxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.pxUsd">
<span class="sig-name descname"><span class="pre">pxUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxUsd'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.pxUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.pxVol">
<span class="sig-name descname"><span class="pre">pxVol</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxVol'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.pxVol" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.quickMgnType">
<span class="sig-name descname"><span class="pre">quickMgnType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quickMgnType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.quickMgnType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.rebate">
<span class="sig-name descname"><span class="pre">rebate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'rebate'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.rebate" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.rebateCcy">
<span class="sig-name descname"><span class="pre">rebateCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'rebateCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.rebateCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.reduceOnly">
<span class="sig-name descname"><span class="pre">reduceOnly</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reduceOnly'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.reduceOnly" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.reqId">
<span class="sig-name descname"><span class="pre">reqId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reqId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.reqId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.side">
<span class="sig-name descname"><span class="pre">side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'side'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.slOrdPx">
<span class="sig-name descname"><span class="pre">slOrdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slOrdPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.slOrdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.slTriggerPx">
<span class="sig-name descname"><span class="pre">slTriggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slTriggerPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.slTriggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.slTriggerPxType">
<span class="sig-name descname"><span class="pre">slTriggerPxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slTriggerPxType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.slTriggerPxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.source">
<span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'source'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.source" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.state">
<span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'state'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.state" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.stpId">
<span class="sig-name descname"><span class="pre">stpId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stpId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.stpId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.stpMode">
<span class="sig-name descname"><span class="pre">stpMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stpMode'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.stpMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.sz">
<span class="sig-name descname"><span class="pre">sz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sz'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.sz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.tdMode">
<span class="sig-name descname"><span class="pre">tdMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tdMode'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.tdMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.tgtCcy">
<span class="sig-name descname"><span class="pre">tgtCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tgtCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.tgtCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.tpOrdPx">
<span class="sig-name descname"><span class="pre">tpOrdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpOrdPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.tpOrdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.tpTriggerPx">
<span class="sig-name descname"><span class="pre">tpTriggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpTriggerPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.tpTriggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.tpTriggerPxType">
<span class="sig-name descname"><span class="pre">tpTriggerPxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpTriggerPxType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.tpTriggerPxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.tradeId">
<span class="sig-name descname"><span class="pre">tradeId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tradeId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.tradeId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSOrder.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSOrder.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">WSPosition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quoteBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseBorrowed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseInterest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quoteBorrowed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quoteInterest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">availPos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avgPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uplRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uplLastPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uplRatioLastPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liqPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">markPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">imr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">margin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mmr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liab</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liabCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tradeId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notionalUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optVal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bizRefId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bizRefType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idxPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bePx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deltaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deltaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gammaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gammaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thetaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thetaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vegaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vegaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotInUseAmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotInUseCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">realizedPnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fundingFee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liqPenalty</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">closeOrderAlgo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#WSPosition"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.adl">
<span class="sig-name descname"><span class="pre">adl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'adl'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.adl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.availPos">
<span class="sig-name descname"><span class="pre">availPos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availPos'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.availPos" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.avgPx">
<span class="sig-name descname"><span class="pre">avgPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'avgPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.avgPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.baseBal">
<span class="sig-name descname"><span class="pre">baseBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'baseBal'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.baseBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.baseBorrowed">
<span class="sig-name descname"><span class="pre">baseBorrowed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'baseBorrowed'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.baseBorrowed" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.baseInterest">
<span class="sig-name descname"><span class="pre">baseInterest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'baseInterest'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.baseInterest" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.bePx">
<span class="sig-name descname"><span class="pre">bePx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bePx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.bePx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.bizRefId">
<span class="sig-name descname"><span class="pre">bizRefId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bizRefId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.bizRefId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.bizRefType">
<span class="sig-name descname"><span class="pre">bizRefType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bizRefType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.bizRefType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.cTime">
<span class="sig-name descname"><span class="pre">cTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.cTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.closeOrderAlgo">
<span class="sig-name descname"><span class="pre">closeOrderAlgo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'closeOrderAlgo'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.closeOrderAlgo" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.deltaBS">
<span class="sig-name descname"><span class="pre">deltaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'deltaBS'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.deltaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.deltaPA">
<span class="sig-name descname"><span class="pre">deltaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'deltaPA'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.deltaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.fee">
<span class="sig-name descname"><span class="pre">fee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fee'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.fee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.fundingFee">
<span class="sig-name descname"><span class="pre">fundingFee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fundingFee'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.fundingFee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.gammaBS">
<span class="sig-name descname"><span class="pre">gammaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'gammaBS'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.gammaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.gammaPA">
<span class="sig-name descname"><span class="pre">gammaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'gammaPA'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.gammaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.idxPx">
<span class="sig-name descname"><span class="pre">idxPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'idxPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.idxPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.imr">
<span class="sig-name descname"><span class="pre">imr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'imr'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.imr" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.interest">
<span class="sig-name descname"><span class="pre">interest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'interest'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.interest" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.last">
<span class="sig-name descname"><span class="pre">last</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'last'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.last" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.lever">
<span class="sig-name descname"><span class="pre">lever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lever'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.lever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.liab">
<span class="sig-name descname"><span class="pre">liab</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liab'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.liab" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.liabCcy">
<span class="sig-name descname"><span class="pre">liabCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liabCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.liabCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.liqPenalty">
<span class="sig-name descname"><span class="pre">liqPenalty</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liqPenalty'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.liqPenalty" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.liqPx">
<span class="sig-name descname"><span class="pre">liqPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liqPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.liqPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.margin">
<span class="sig-name descname"><span class="pre">margin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'margin'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.margin" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.markPx">
<span class="sig-name descname"><span class="pre">markPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'markPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.markPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.mgnMode">
<span class="sig-name descname"><span class="pre">mgnMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnMode'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.mgnMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.mgnRatio">
<span class="sig-name descname"><span class="pre">mgnRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnRatio'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.mgnRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.mmr">
<span class="sig-name descname"><span class="pre">mmr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mmr'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.mmr" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'adl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'availPos':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'avgPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'baseBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'baseBorrowed':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'baseInterest':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bePx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bizRefId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bizRefType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'closeOrderAlgo':</span> <span class="pre">FieldInfo(annotation=List[dict],</span> <span class="pre">required=True),</span> <span class="pre">'deltaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'deltaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fundingFee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'gammaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'gammaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'idxPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'imr':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'interest':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lever':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liab':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liabCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liqPenalty':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liqPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'margin':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'markPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnRatio':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mmr':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'notionalUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'optVal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pos':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quoteBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quoteBorrowed':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quoteInterest':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'realizedPnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotInUseAmt':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotInUseCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'thetaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'thetaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tradeId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'upl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uplLastPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uplRatio':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uplRatioLastPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'usdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'vegaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'vegaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.notionalUsd">
<span class="sig-name descname"><span class="pre">notionalUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'notionalUsd'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.notionalUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.optVal">
<span class="sig-name descname"><span class="pre">optVal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'optVal'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.optVal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.pTime">
<span class="sig-name descname"><span class="pre">pTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.pTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.pnl">
<span class="sig-name descname"><span class="pre">pnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pnl'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.pnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.pos">
<span class="sig-name descname"><span class="pre">pos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pos'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.pos" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.posCcy">
<span class="sig-name descname"><span class="pre">posCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.posCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.posId">
<span class="sig-name descname"><span class="pre">posId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.posId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.quoteBal">
<span class="sig-name descname"><span class="pre">quoteBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quoteBal'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.quoteBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.quoteBorrowed">
<span class="sig-name descname"><span class="pre">quoteBorrowed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quoteBorrowed'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.quoteBorrowed" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.quoteInterest">
<span class="sig-name descname"><span class="pre">quoteInterest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quoteInterest'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.quoteInterest" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.realizedPnl">
<span class="sig-name descname"><span class="pre">realizedPnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'realizedPnl'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.realizedPnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.spotInUseAmt">
<span class="sig-name descname"><span class="pre">spotInUseAmt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotInUseAmt'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.spotInUseAmt" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.spotInUseCcy">
<span class="sig-name descname"><span class="pre">spotInUseCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotInUseCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.spotInUseCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.thetaBS">
<span class="sig-name descname"><span class="pre">thetaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'thetaBS'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.thetaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.thetaPA">
<span class="sig-name descname"><span class="pre">thetaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'thetaPA'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.thetaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.tradeId">
<span class="sig-name descname"><span class="pre">tradeId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tradeId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.tradeId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.upl">
<span class="sig-name descname"><span class="pre">upl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'upl'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.upl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.uplLastPx">
<span class="sig-name descname"><span class="pre">uplLastPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uplLastPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.uplLastPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.uplRatio">
<span class="sig-name descname"><span class="pre">uplRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uplRatio'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.uplRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.uplRatioLastPx">
<span class="sig-name descname"><span class="pre">uplRatioLastPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uplRatioLastPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.uplRatioLastPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.usdPx">
<span class="sig-name descname"><span class="pre">usdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'usdPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.usdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.vegaBS">
<span class="sig-name descname"><span class="pre">vegaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'vegaBS'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.vegaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WSPosition.vegaPA">
<span class="sig-name descname"><span class="pre">vegaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'vegaPA'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WSPosition.vegaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WebSocketConnectionConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">WebSocketConnectionConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channels</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wss_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#WebSocketConnectionConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.WebSocketConnectionConfig" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WebSocketConnectionConfig.channels">
<span class="sig-name descname"><span class="pre">channels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'channels'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.channels" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WebSocketConnectionConfig.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WebSocketConnectionConfig.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'channels':</span> <span class="pre">FieldInfo(annotation=dict,</span> <span class="pre">required=False,</span> <span class="pre">default={}),</span> <span class="pre">'name':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'wss_url':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WebSocketConnectionConfig.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WebSocketConnectionConfig.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'name'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.name" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.WebSocketConnectionConfig.wss_url">
<span class="sig-name descname"><span class="pre">wss_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'wss_url'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.WebSocketConnectionConfig.wss_url" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_balData_element">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">ws_balData_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cashBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#ws_balData_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.ws_balData_element" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_balData_element.cashBal">
<span class="sig-name descname"><span class="pre">cashBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cashBal'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_balData_element.cashBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_balData_element.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_balData_element.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_balData_element.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_balData_element.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_balData_element.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cashBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_balData_element.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_balData_element.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.ws_balData_element.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_balData_element.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_balData_element.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">ws_posData_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tradeId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avgPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#ws_posData_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.avgPx">
<span class="sig-name descname"><span class="pre">avgPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'avgPx'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.avgPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.mgnMode">
<span class="sig-name descname"><span class="pre">mgnMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnMode'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.mgnMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'avgPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pos':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tradeId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.pos">
<span class="sig-name descname"><span class="pre">pos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pos'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.pos" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.posCcy">
<span class="sig-name descname"><span class="pre">posCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posCcy'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.posCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.posId">
<span class="sig-name descname"><span class="pre">posId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.posId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.tradeId">
<span class="sig-name descname"><span class="pre">tradeId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tradeId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.tradeId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_posData_element.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_posData_element.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_trades_element">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.ws_data_structures.</span></span><span class="sig-name descname"><span class="pre">ws_trades_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tradeId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/ws_data_structures.html#ws_trades_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.ws_data_structures.ws_trades_element" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_trades_element.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_trades_element.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_trades_element.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_trades_element.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_trades_element.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tradeId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_trades_element.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_trades_element.model_post_init">
<span class="sig-name descname"><span class="pre">model_post_init</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">__context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pyokx.ws_data_structures.ws_trades_element.model_post_init" title="Link to this definition"></a></dt>
<dd><p>This function is meant to behave like a BaseModel method to initialise private attributes.</p>
<p>It takes context as an argument since that’s what pydantic-core passes when calling it.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>self</strong> – The BaseModel instance.</p></li>
<li><p><strong>__context</strong> – The context.</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.ws_data_structures.ws_trades_element.tradeId">
<span class="sig-name descname"><span class="pre">tradeId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tradeId'</span></em><a class="headerlink" href="#pyokx.ws_data_structures.ws_trades_element.tradeId" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<div class="graphviz"><img src="_images/inheritance-f690ec9b186f167e692ecf92f11e48fcf8cf4823.png" alt="Inheritance diagram of pyokx.ws_data_structures" usemap="#inheritance3797aa8078" class="inheritance graphviz" /></div>
<map id="inheritance3797aa8078" name="inheritance3797aa8078">
<area shape="rect" id="node1" href="#pyokx.ws_data_structures.AccountChannel" target="_top" title="AccountChannel" alt="" coords="223,3,294,17"/>
<area shape="rect" id="node2" href="pyokx.data_structures.html#pyokx.data_structures.OKXBaseModel" target="_top" title="OKXBaseModel" alt="" coords="83,569,151,583"/>
<area shape="rect" id="node3" href="#pyokx.ws_data_structures.AccountChannelInputArgs" target="_top" title="AccountChannelInputArgs" alt="" coords="206,31,312,45"/>
<area shape="rect" id="node4" href="#pyokx.ws_data_structures.AccountChannelReturnArgs" target="_top" title="AccountChannelReturnArgs" alt="" coords="203,58,314,72"/>
<area shape="rect" id="node5" href="#pyokx.ws_data_structures.BalanceAndPositionData" target="_top" title="BalanceAndPositionData" alt="" coords="207,86,310,100"/>
<area shape="rect" id="node6" href="#pyokx.ws_data_structures.BalanceAndPositionsChannel" target="_top" title="BalanceAndPositionsChannel" alt="" coords="200,113,317,128"/>
<area shape="rect" id="node7" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelInputArgs" target="_top" title="BalanceAndPositionsChannelInputArgs" alt="" coords="182,141,335,155"/>
<area shape="rect" id="node8" href="#pyokx.ws_data_structures.BalanceAndPositionsChannelReturnArgs" target="_top" title="BalanceAndPositionsChannelReturnArgs" alt="" coords="179,169,338,183"/>
<area shape="rect" id="node10" href="#pyokx.ws_data_structures.CandleStick" target="_top" title="CandleStick" alt="" coords="231,196,286,210"/>
<area shape="rect" id="node11" href="#pyokx.ws_data_structures.IndexCandleSticksChannel" target="_top" title="IndexCandleSticksChannel" alt="" coords="204,224,313,238"/>
<area shape="rect" id="node12" href="#pyokx.ws_data_structures.IndexCandleSticksChannelInputArgs" target="_top" title="IndexCandleSticksChannelInputArgs" alt="" coords="187,251,331,266"/>
<area shape="rect" id="node13" href="#pyokx.ws_data_structures.IndexTickers" target="_top" title="IndexTickers" alt="" coords="229,279,288,293"/>
<area shape="rect" id="node14" href="#pyokx.ws_data_structures.IndexTickersChannel" target="_top" title="IndexTickersChannel" alt="" coords="215,307,303,321"/>
<area shape="rect" id="node15" href="#pyokx.ws_data_structures.IndexTickersChannelInputArgs" target="_top" title="IndexTickersChannelInputArgs" alt="" coords="197,334,320,348"/>
<area shape="rect" id="node16" href="#pyokx.ws_data_structures.InstrumentsChannel" target="_top" title="InstrumentsChannel" alt="" coords="216,362,301,376"/>
<area shape="rect" id="node17" href="#pyokx.ws_data_structures.InstrumentsChannelInputArgs" target="_top" title="InstrumentsChannelInputArgs" alt="" coords="198,389,319,404"/>
<area shape="rect" id="node18" href="#pyokx.ws_data_structures.MarkPrice" target="_top" title="MarkPrice" alt="" coords="234,417,283,431"/>
<area shape="rect" id="node19" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannel" target="_top" title="MarkPriceCandleSticksChannel" alt="" coords="196,445,321,459"/>
<area shape="rect" id="node20" href="#pyokx.ws_data_structures.MarkPriceCandleSticksChannelInputArgs" target="_top" title="MarkPriceCandleSticksChannelInputArgs" alt="" coords="178,472,339,486"/>
<area shape="rect" id="node21" href="#pyokx.ws_data_structures.MarkPriceChannel" target="_top" title="MarkPriceChannel" alt="" coords="219,500,298,514"/>
<area shape="rect" id="node22" href="#pyokx.ws_data_structures.MarkPriceChannelInputArgs" target="_top" title="MarkPriceChannelInputArgs" alt="" coords="202,528,315,542"/>
<area shape="rect" id="node23" href="#pyokx.ws_data_structures.OrderBookChannel" target="_top" title="OrderBookChannel" alt="" coords="218,555,299,569"/>
<area shape="rect" id="node24" href="#pyokx.ws_data_structures.OrderBookData" target="_top" title="OrderBookData" alt="" coords="224,583,293,597"/>
<area shape="rect" id="node25" href="#pyokx.ws_data_structures.OrderBookInputArgs" target="_top" title="OrderBookInputArgs" alt="" coords="216,610,301,624"/>
<area shape="rect" id="node26" href="#pyokx.ws_data_structures.OrderBookReturnArgs" target="_top" title="OrderBookReturnArgs" alt="" coords="213,638,304,652"/>
<area shape="rect" id="node27" href="#pyokx.ws_data_structures.OrdersChannel" target="_top" title="OrdersChannel" alt="" coords="225,666,292,680"/>
<area shape="rect" id="node28" href="#pyokx.ws_data_structures.OrdersChannelInputArgs" target="_top" title="OrdersChannelInputArgs" alt="" coords="208,693,309,707"/>
<area shape="rect" id="node29" href="#pyokx.ws_data_structures.OrdersChannelReturnArgs" target="_top" title="OrdersChannelReturnArgs" alt="" coords="205,721,312,735"/>
<area shape="rect" id="node30" href="#pyokx.ws_data_structures.PositionsChannel" target="_top" title="PositionsChannel" alt="" coords="221,748,296,763"/>
<area shape="rect" id="node31" href="#pyokx.ws_data_structures.PositionsChannelInputArgs" target="_top" title="PositionsChannelInputArgs" alt="" coords="204,776,313,790"/>
<area shape="rect" id="node32" href="#pyokx.ws_data_structures.PositionsChannelReturnArgs" target="_top" title="PositionsChannelReturnArgs" alt="" coords="201,804,316,818"/>
<area shape="rect" id="node33" href="#pyokx.ws_data_structures.PriceLimit" target="_top" title="PriceLimit" alt="" coords="234,831,283,845"/>
<area shape="rect" id="node34" href="#pyokx.ws_data_structures.PriceLimitChannel" target="_top" title="PriceLimitChannel" alt="" coords="219,859,298,873"/>
<area shape="rect" id="node35" href="#pyokx.ws_data_structures.PriceLimitChannelInputArgs" target="_top" title="PriceLimitChannelInputArgs" alt="" coords="202,886,315,901"/>
<area shape="rect" id="node36" href="#pyokx.ws_data_structures.TickersChannel" target="_top" title="TickersChannel" alt="" coords="225,914,292,928"/>
<area shape="rect" id="node37" href="#pyokx.ws_data_structures.TickersChannelInputArgs" target="_top" title="TickersChannelInputArgs" alt="" coords="207,942,310,956"/>
<area shape="rect" id="node38" href="#pyokx.ws_data_structures.TickersChannelReturnArgs" target="_top" title="TickersChannelReturnArgs" alt="" coords="204,969,313,983"/>
<area shape="rect" id="node39" href="#pyokx.ws_data_structures.WSOrder" target="_top" title="WSOrder" alt="" coords="237,997,281,1011"/>
<area shape="rect" id="node40" href="#pyokx.ws_data_structures.WSPosition" target="_top" title="WSPosition" alt="" coords="232,1024,285,1039"/>
<area shape="rect" id="node41" href="#pyokx.ws_data_structures.WebSocketConnectionConfig" target="_top" title="WebSocketConnectionConfig" alt="" coords="201,1052,316,1066"/>
<area shape="rect" id="node42" href="#pyokx.ws_data_structures.ws_balData_element" target="_top" title="ws_balData_element" alt="" coords="214,1080,303,1094"/>
<area shape="rect" id="node43" href="#pyokx.ws_data_structures.ws_posData_element" target="_top" title="ws_posData_element" alt="" coords="213,1107,304,1121"/>
<area shape="rect" id="node44" href="#pyokx.ws_data_structures.ws_trades_element" target="_top" title="ws_trades_element" alt="" coords="217,1135,300,1149"/>
</map></section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="pyokx.ws_clients.WsUtils.html" class="btn btn-neutral float-left" title="pyokx.ws_clients.WsUtils" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="redis_tools.config.html" class="btn btn-neutral float-right" title="redis_tools.config" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2024, Ruben Fernandez Carbon.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>